Closes #4334: sphinx-apidoc: References to non-existing files in TOC #4335
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arcivanov
reviewed
Dec 23, 2017
| @@ -116,7 +116,12 @@ def create_package_file(root, master_package, subroot, py_files, opts, subs, is_ | |||
| text += '\n' | |||
|
|
|||
| # build a list of directories that are szvpackages (contain an INITPY file) | |||
| subs = [sub for sub in subs if path.isfile(path.join(root, sub, INITPY))] | |||
| # and also checks the INITPY file is not empty, or there are other python | |||
There was a problem hiding this comment.
an empty INITPY is still a valid INITPY making the directory a package as opposed to namespace
There was a problem hiding this comment.
True. But before this patch there would be a reference to that package, although the package .rst file would never be created. It seems to have been the behaviour of apidoc.py since many years to exclude those packages.
See:
Lines 159 to 169 in 87cebf1
That's why I'm reluctant to change an existing deliberate design, but tried to fix the inconsistency. If we change the behaviour in apidoc.py to not skip empty init.py files in shall_skip it'd still be consistent. @birkenfeld ?
tk0miya
approved these changes
Jan 1, 2018
|
Thank you for contribution! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Subject: Don't generate references to non-existing files in in TOC of python packages or modules
Feature or Bugfix
Purpose
Detail
Relates